Esx Settings Clusters Configuration ApplySpec

Esx Settings Clusters Configuration ApplySpec
Esx Settings Clusters Configuration ApplySpec

The Esx Settings Clusters Configuration ApplySpec schema contains properties that describe the specification to be used for applying the desired configuration to a cluster.

This schema was added in vSphere API 8.0.1.0.

JSON Example
{
    "commit": "string",
    "hosts": [
        "string"
    ],
    "apply_policy_spec": {
        "failure_action": {
            "action": "string",
            "retry_delay": 0,
            "retry_count": 0
        },
        "pre_remediation_power_action": "string",
        "enable_quick_boot": false,
        "disable_dpm": false,
        "disable_hac": false,
        "evacuate_offline_vms": false,
        "enforce_hcl_validation": false,
        "parallel_remediation_action": {
            "enabled": false,
            "max_hosts": 0
        },
        "enforce_quick_patch": false,
        "config_manager_policy_spec": {
            "serial_remediation": false
        }
    }
}
string
commit
Optional

The minimum commit identifier of the desired configuration to be used during the POST /esx/settings/clusters/{cluster}/configuration?action=apply operation.

This property was added in vSphere API 8.0.1.0.

if missing or null or empty the apply operation will use the latest commit to fetch the desired configuration.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

array of string
hosts
Optional

The specific hosts within the cluster to be considered during the POST /esx/settings/clusters/{cluster}/configuration?action=apply operation.

This property was added in vSphere API 8.0.1.0.

if missing or null or empty the POST /esx/settings/clusters/{cluster}/configuration?action=apply operation will remediate all hosts within the cluster.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

apply_policy_spec
Optional

The parameter can be used to override the default remediation policies for the task.

This property was added in vSphere API 8.0.1.0.

if missing or null the default cluster remediation policies are used.